com.highdeal.pnr.hci

Class CleanupException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.CleanupException

All Implemented Interfaces:

OperationResult, XMLMarshallable, Serializable

public class CleanupException
extends OperationFailureException

Exception thrown during the processing of a cleanup operation request in the connected SAP CC system; The exception is registered in the operation results.

The main reasons are:

• The invalidSubscriptionCode error occurs when the given code is null or does not correspond to a subscription in the database.
• The invalidResultType occurs when the result type is unknown.
• The invalidToDate error occurs when the given date is null.
• The incompatibleCurrencies occurs when aggregating the total amounts of different currencies.

Note

Consult the field summary and the field details for the complete list of reasons and detailed information.

See Also:

AsyncStatefulServiceClient, StatefulServiceClient, Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="cleanupFault">
                  <xs:complexType>
                     <xs:attribute name="reason" type="CleanupFaultType"/>
                     <xs:attribute name="message" type="xs:string"/>
                  </xs:complexType>
               </xs:element>

<xs:simpleType name="CleanupFaultType">
                  <xs:restriction base="xs:string">
                     <xs:enumeration value="invalidSubscriberAccountCode"/>
                     <xs:enumeration value="invalidServiceProvider"/>
                     <xs:enumeration value="invalidSubscriptionOid"/>
                     <xs:enumeration value="invalidToDate"/>
                     <xs:enumeration value="invalidResultType"/>
                     <xs:enumeration value="incompatibleCurrencies"/>
                     <xs:enumeration value="cleanupProcessAlreadyRunning"/>
                     <xs:enumeration value="dispatcherCommunicationFailed"/>
                     <xs:enumeration value="unknown"/>
                  </xs:restriction>
               </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLEANUP_PROCESS_ALREADY_RUNNING 6: Constant for cleanupProcesssAlreadyRunning error.
static int	DISPATCHER_COMMUNICATION_FAILED 7: Constant for dispatcherCommunicationFailed error
static int	INCOMPATIBLE_CURRENCIES 5: Constant for incompatibleCurrencies error
static int	INVALID_RESULT_TYPE 4: Constant for invalidResultType error
static int	INVALID_SERVICE_PROVIDER 1: Constant for invalidServiceProvider error
static int	INVALID_SUBSCRIBER_ACCOUNT_CODE 0: Constant for invalidSubscriberAccountCode error
static int	INVALID_SUBSCRIPTION_OID 2: Constant for invalidSubscriptionOid error
static int	INVALID_TO_DATE 3: Constant for invalidToDate error
static String	OPERATION_NAME The XML name: "cleanupFault"
static int	UNKNOWN -1: Constant for unknown error

Constructor Summary

Constructors

Constructor and Description
CleanupException() Constructs an empty exception.
CleanupException(int reason, String message) Creates a new CleanupException with a reason and a message.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getMessage() Gets the recorded detailed message for this CleanupException.
int	getReason() Gets the recorded reason of this CleanupException for further investigations.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setMessage(String message) SAP CC sets up the message for this CleanupException.
void	setReason(int reason) SAP CC sets up the reason of this CleanupException.
String	toString()

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

The XML name: "cleanupFault"

See Also:

Constant Field Values

INVALID_SUBSCRIBER_ACCOUNT_CODE

public static final int INVALID_SUBSCRIBER_ACCOUNT_CODE

0: Constant for invalidSubscriberAccountCode error

See Also:

Constant Field Values

INVALID_SERVICE_PROVIDER

public static final int INVALID_SERVICE_PROVIDER

1: Constant for invalidServiceProvider error

See Also:

Constant Field Values

INVALID_SUBSCRIPTION_OID

public static final int INVALID_SUBSCRIPTION_OID

2: Constant for invalidSubscriptionOid error

See Also:

Constant Field Values

INVALID_TO_DATE

public static final int INVALID_TO_DATE

3: Constant for invalidToDate error

See Also:

Constant Field Values

INVALID_RESULT_TYPE

public static final int INVALID_RESULT_TYPE

4: Constant for invalidResultType error

See Also:

Constant Field Values

INCOMPATIBLE_CURRENCIES

public static final int INCOMPATIBLE_CURRENCIES

5: Constant for incompatibleCurrencies error

See Also:

Constant Field Values

CLEANUP_PROCESS_ALREADY_RUNNING

public static final int CLEANUP_PROCESS_ALREADY_RUNNING

6: Constant for cleanupProcesssAlreadyRunning error. A cleanup process is still running.

See Also:

Constant Field Values

DISPATCHER_COMMUNICATION_FAILED

public static final int DISPATCHER_COMMUNICATION_FAILED

7: Constant for dispatcherCommunicationFailed error

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

-1: Constant for unknown error

See Also:

Constant Field Values

Constructor Detail

CleanupException

public CleanupException()

Constructs an empty exception.

CleanupException

public CleanupException(int reason,
                        String message)

Creates a new CleanupException with a reason and a message.

Parameters:

reason - The reason

message - The additional message

See Also:

INVALID_SUBSCRIBER_ACCOUNT_CODE, INVALID_SERVICE_PROVIDER, INVALID_SUBSCRIPTION_OID, INVALID_TO_DATE, INVALID_RESULT_TYPE, INCOMPATIBLE_CURRENCIES, CLEANUP_PROCESS_ALREADY_RUNNING, UNKNOWN

Method Detail

setReason

public void setReason(int reason)

SAP CC sets up the reason of this CleanupException.

Parameters:

reason - The reason of this CleanupException

getReason

public int getReason()

Gets the recorded reason of this CleanupException for further investigations.

Returns:

The reason of this CleanupException

See Also:

getMessage(), INVALID_SUBSCRIBER_ACCOUNT_CODE, INVALID_TO_DATE, INVALID_RESULT_TYPE, INCOMPATIBLE_CURRENCIES, CLEANUP_PROCESS_ALREADY_RUNNING, DISPATCHER_COMMUNICATION_FAILED, UNKNOWN

setMessage

public void setMessage(String message)

SAP CC sets up the message for this CleanupException.

Parameters:

message - The message for this CleanupException

getMessage

public String getMessage()

Gets the recorded detailed message for this CleanupException.

Overrides:

getMessage in class Throwable

Returns:

The text message of this CleanupException

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Parameters:

output - The XML output to marshal the object into

toString

public String toString()

Overrides:

toString in class Throwable